Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deploy docs #47

Closed
wants to merge 1 commit into from
Closed

Deploy docs #47

wants to merge 1 commit into from

Conversation

krishnans2006
Copy link
Member

Currently a work-in-progress, using sphinx-to-github-pages.

@krishnans2006 krishnans2006 self-assigned this Jun 9, 2024
@krishnans2006 krishnans2006 requested a review from a team as a code owner June 9, 2024 06:48
@krishnans2006
Copy link
Member Author

The error:

  Running Sphinx v7.3.7
  
  Configuration error:
  The module you specified in the configuration 'django_settings' in your conf.py cannot be imported. Make sure the module path is correct and the source directory is added to sys.path.
  Error: Process completed with exit code 1.

@JasonGrace2282
Copy link
Member

JasonGrace2282 commented Jun 9, 2024

Might be a good idea to lock in the python version (the default is python 3.10, but it's better to be explicit, especially with #22 coming up)

On another note, are you able to reproduce the issue locally? I am not...

If needed we can do it manually with something like this, which works in the testing ci

name: Deploy docs

on:
  push:
    branches: [master]

permissions:
  contents: write

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
      - name: Install dependencies
        run: |
          pip install -r docs/requirements.txt
      - name: Sphinx build
        run: |

          cd docs
          make html
       - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: './build'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

@krishnans2006
Copy link
Member Author

On another note, are you able to reproduce the issue locally? I am not...

I'm not able to either - I did a bunch of testing and it seems like the root directory is indeed added to sys.path, which is quite interesting.

Your workflow idea looks pretty amazing - I'll try it out.

@krishnans2006 krishnans2006 force-pushed the master branch 7 times, most recently from c03ce92 to 090d035 Compare June 9, 2024 20:47
@krishnans2006
Copy link
Member Author

Done! Implemented in 173a7d8.

@krishnans2006 krishnans2006 deleted the docs branch June 9, 2024 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants